[Feat] Implement room mention actionable whisper #41406

fedirjh · 2024-05-01T11:35:41Z

Details

Fixed Issues

Tests

Open App and navigate to any chat room
Create a new thread
Tag a non-existing user in the thread
Verify a mention whisper is displayed
Copy the thread id and run this code in the chrome console

async function convertMentionToReport(reportId) {
  const actions = await Onyx.get('reportActions_'+reportId);
  const action = Object.values(actions).filter(({actionName}) => actionName === 'ACTIONABLEMENTIONWHISPER')
  if (action.length) {
    Onyx.merge('reportActions_' + reportId, {
      [action[0].reportActionID]: {
        actionName: 'ACTIONABLEREPORTMENTIONWHISPER'
      }});
  }
}
await convertMentionToReport(id) // thread id from step 5

Verify the whisper buttons are updated
Press create it and verify there is a command call to ResolveActionableReportMentionWhisper
Verify that the whisper disappear

Verify that no errors appear in the JS console

Offline tests

QA Steps

Verify that no errors appear in the JS console

PR Author Checklist

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

MacOS: Chrome / Safari

CleanShot.2024-05-01.at.12.32.47.mp4

MacOS: Desktop

CleanShot.2024-05-01.at.13.32.21.mp4

…handling actionable room mention whispers.

…ion in 'Report.ts' by removing redundant message data.

This commit refactors the functions and conditions related to actionable whispers in report actions. The changes aim to improve the code's maintainability by reducing complexity and improving readability, which will make future modifications to this part of the codebase easier.

rlinoz · 2024-05-01T15:20:33Z

Sorry, I updated the GH but forgot about the doc, can we rename to ACTIONABLE_REPORT_MENTION_WHISPER instead of ROOM?

…tion'. This change occurred in various files across the application, including action handlers, type definitions, API parameters, and translations.

fedirjh · 2024-05-01T16:04:23Z

Sorry, I updated the GH but forgot about the doc, can we rename to ACTIONABLE_REPORT_MENTION_WHISPER instead of ROOM?

@rlinoz I updated all methods and components to reflect the new name. Let me know if that works.

melvin-bot · 2024-05-01T17:42:43Z

@ishpaul777 Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

ishpaul777 · 2024-05-01T18:26:13Z

Reviewer Checklist

I have verified the author checklist is complete (all boxes are checked off).
I verified the correct issue is linked in the ### Fixed Issues section above
I verified testing steps are clear and they cover the changes made in this PR
- I verified the steps for local testing are in the Tests section
- I verified the steps for Staging and/or Production testing are in the QA steps section
- I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
- I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
I checked that screenshots or videos are included for tests on all platforms
I included screenshots or videos for tests on all platforms
I verified tests pass on all platforms & I tested again on:
- Android: Native
- Android: mWeb Chrome
- iOS: Native
- iOS: mWeb Safari
- MacOS: Chrome / Safari
- MacOS: Desktop
If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
I verified proper code patterns were followed (see Reviewing the code)
- I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
- I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
- I verified that comments were added to code that is not self explanatory
- I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
- I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
- I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
- I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is either coming verbatim from figma or has been approved by marketing (in order to get marketing approval, ask the Bug Zero team member to add the Waiting for copy label to the issue)
- I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
- I verified the JSDocs style guidelines (in STYLE.md) were followed
If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
I verified that this PR follows the guidelines as stated in the Review Guidelines
I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
If a new component is created I verified that:
- A similar component doesn't exist in the codebase
- All props are defined accurately and each prop has a /** comment above it */
- The file is named correctly
- The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
- The only data being stored in the state is data necessary for rendering and nothing else
- For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
- Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
- All JSX used for rendering exists in the render method
- The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
If any new file was added I verified that:
- The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
If a new CSS style is added I verified that:
- A similar style doesn't already exist
- The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(theme.componentBG)
If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
If the PR modifies the UI (e.g. new buttons, new UI components, changing the padding/spacing/sizing, moving components, etc) or modifies the form input styles:
- I verified that all the inputs inside a form are aligned with each other.
- I added Design label and/or tagged @Expensify/design so the design team can review the changes.
If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Android: Native

Android: mWeb Chrome

iOS: Native

iOS: mWeb Safari

Screen.Recording.2024-05-02.at.1.03.35.AM.mov

MacOS: Chrome / Safari

Screen.Recording.2024-05-02.at.1.04.08.AM.mov

MacOS: Desktop

Screen.Recording.2024-05-02.at.2.08.44.AM.mov

ishpaul777 · 2024-05-01T18:56:23Z

hey @fedirjh how do i test this for native device? (where do i run the onyx merge command to change ACTIONABLEMENTIONWHISPER to ACTIONABLEREPORTMENTIONWHISPER)

fedirjh · 2024-05-01T18:59:33Z

Hey @ishpaul777 . I just added the code inside the Expensify.js file.

ishpaul777 · 2024-05-01T19:04:30Z

oh okay! but how do you get this whisper if BE is not ready yet

fedirjh · 2024-05-01T19:25:17Z

@ishpaul777 I just built it manually. I cloned the mention whisper report action object and updated the data.

src/libs/actions/Report.ts

rlinoz · 2024-05-01T20:41:06Z

Just a quick updated, I am finishing the automated tests in the backend then I will provide a .env so we can test this properly.

rlinoz

It is working pretty well, just some minor things.

src/CONST.ts

src/pages/home/report/ReportActionItem.tsx

src/languages/es.ts

…iles Replaced 'YES' and 'NO' resolutions for actionable report mentions with 'CREATE' and 'NOTHING' respectively. This improves the clarity of the mentioned actions across the application.

rlinoz

Just one more update, other than that I think we are good!

src/languages/en.ts

OSBotify · 2024-05-06T17:37:27Z

✋ This PR was not deployed to staging yet because QA is ongoing. It will be automatically deployed to staging after the next production release.

OSBotify · 2024-05-09T02:11:31Z

🚀 Deployed to production by https://github.com/marcaaron in version: 1.4.71-6 🚀

platform	result
🤖 android 🤖	success ✅
🖥 desktop 🖥	success ✅
🍎 iOS 🍎	success ✅
🕸 web 🕸	success ✅

ishpaul777 · 2024-08-12T17:48:21Z

👋 This PR introduced the room-mention actionable whispers but we dont hide it from LHN subtext once resolved, this has caused #43737

fedirjh added 6 commits May 1, 2024 09:19

[Chore]: Add const and types for ACTIONABLE_ROOM_MENTION_WHISPER

6567d31

[Chore]: Add ResolveActionableRoomMentionWhisper Command

de7a1a1

[Chore]: Add isActionableRoomMentionWhisper function and options for …

f766bdf

…handling actionable room mention whispers.

[Refactor] Simplified the 'resolveActionableRoomMentionWhisper' funct…

39d787d

…ion in 'Report.ts' by removing redundant message data.

[Chore] Add ResolveActionableRoomMentionWhisperParams to WRITE_COMMANDS.

911315c

rlinoz self-requested a review May 1, 2024 13:50

[Refactor]: Rename 'RoomMention' components and methods to 'ReportMen…

1c2aa19

…tion'. This change occurred in various files across the application, including action handlers, type definitions, API parameters, and translations.

fedirjh marked this pull request as ready for review May 1, 2024 17:42

fedirjh requested a review from a team as a code owner May 1, 2024 17:42

melvin-bot bot requested review from ishpaul777 and removed request for a team May 1, 2024 17:42

ishpaul777 reviewed May 1, 2024

View reviewed changes

src/libs/actions/Report.ts Outdated Show resolved Hide resolved

[Chore]: Remove redundant code

9abd4bb

rlinoz requested changes May 2, 2024

View reviewed changes

src/CONST.ts Outdated Show resolved Hide resolved

src/pages/home/report/ReportActionItem.tsx Outdated Show resolved Hide resolved

rlinoz reviewed May 2, 2024

View reviewed changes

src/languages/es.ts Outdated Show resolved Hide resolved

fedirjh added 2 commits May 2, 2024 18:55

[Refactor]: Update action resolutions in ReportActionItem and CONST f…

21ceb1e

…iles Replaced 'YES' and 'NO' resolutions for actionable report mentions with 'CREATE' and 'NOTHING' respectively. This improves the clarity of the mentioned actions across the application.

Merge branch 'main' into room-mention-actionable-whisper

21dc928

fedirjh requested a review from rlinoz May 2, 2024 18:14

rlinoz requested changes May 3, 2024

View reviewed changes

src/languages/en.ts Outdated Show resolved Hide resolved

[Chore]: Refactor actionable report mention whisper options

12b5f75

ishpaul777 approved these changes May 3, 2024

View reviewed changes

melvin-bot bot requested a review from rlinoz May 3, 2024 19:20

rlinoz approved these changes May 6, 2024

View reviewed changes

rlinoz merged commit 8962677 into Expensify:main May 6, 2024
15 of 17 checks passed

github-actions bot mentioned this pull request May 7, 2024

Deploy Checklist: New Expensify 2024-05-07 #41716

Closed

izarutskaya mentioned this pull request May 8, 2024

Chat - Mention whisper returns, incorrect mention buttons #41833

Closed

6 tasks

fedirjh deleted the room-mention-actionable-whisper branch May 9, 2024 12:43

ishpaul777 mentioned this pull request Aug 12, 2024

[HOLD] [Help Wanted for completing] [$250] LHN - System message remains on LHN when create new room via announce room #43737

Open

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Feat] Implement room mention actionable whisper #41406

[Feat] Implement room mention actionable whisper #41406

fedirjh commented May 1, 2024 •

edited

Loading

rlinoz commented May 1, 2024

fedirjh commented May 1, 2024

melvin-bot bot commented May 1, 2024

ishpaul777 commented May 1, 2024 •

edited

Loading

ishpaul777 commented May 1, 2024 •

edited

Loading

fedirjh commented May 1, 2024

ishpaul777 commented May 1, 2024

fedirjh commented May 1, 2024

rlinoz commented May 1, 2024

rlinoz left a comment

rlinoz left a comment

OSBotify commented May 6, 2024

OSBotify commented May 9, 2024

ishpaul777 commented Aug 12, 2024 •

edited

Loading

[Feat] Implement room mention actionable whisper #41406

[Feat] Implement room mention actionable whisper #41406

Conversation

fedirjh commented May 1, 2024 • edited Loading

Details

Fixed Issues

Tests

Offline tests

QA Steps

PR Author Checklist

Screenshots/Videos

rlinoz commented May 1, 2024

fedirjh commented May 1, 2024

melvin-bot bot commented May 1, 2024

ishpaul777 commented May 1, 2024 • edited Loading

Reviewer Checklist

Screenshots/Videos

ishpaul777 commented May 1, 2024 • edited Loading

fedirjh commented May 1, 2024

ishpaul777 commented May 1, 2024

fedirjh commented May 1, 2024

rlinoz commented May 1, 2024

rlinoz left a comment

Choose a reason for hiding this comment

rlinoz left a comment

Choose a reason for hiding this comment

OSBotify commented May 6, 2024

OSBotify commented May 9, 2024

ishpaul777 commented Aug 12, 2024 • edited Loading

fedirjh commented May 1, 2024 •

edited

Loading

ishpaul777 commented May 1, 2024 •

edited

Loading

ishpaul777 commented May 1, 2024 •

edited

Loading

ishpaul777 commented Aug 12, 2024 •

edited

Loading